<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow: log/detail/serial_file_logger.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_9381a7bbd03577d6d8720c7f35c94ffa.html">log</a></li><li class="navelem"><a class="el" href="dir_1efabf1cd0b709973fdc844b590473f2.html">detail</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">serial_file_logger.cpp</div></div>
</div><!--header-->
<div class="contents">
<a href="serial__file__logger_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#include &quot;<a class="code" href="serial__file__logger_8hpp.html">flow/log/detail/serial_file_logger.hpp</a>&quot;</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="preprocessor">#include &quot;<a class="code" href="config_8hpp.html">flow/log/config.hpp</a>&quot;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceflow_1_1log.html">flow::log</a></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span>{</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="comment">// Implementations.</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="classflow_1_1log_1_1Serial__file__logger.html#a979efc0eb7577c2175c8fe9debdced94">   27</a></span><a class="code hl_function" href="classflow_1_1log_1_1Serial__file__logger.html#a979efc0eb7577c2175c8fe9debdced94">Serial_file_logger::Serial_file_logger</a>(<a class="code hl_class" href="classflow_1_1log_1_1Logger.html">Logger</a>* backup_logger_ptr,</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>                                       <a class="code hl_class" href="classflow_1_1log_1_1Config.html">Config</a>* config, <span class="keyword">const</span> fs::path&amp; log_path) :</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span>  <span class="comment">/* Set up the logging *about our real attempts at file logging, probably to a Simple_ostream_logger/cout;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment">   * or to null (meaning no such logging).  Either way we will still attempt to actually log user-requested messages</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment">   * to log_path! */</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>  <a class="code hl_class" href="classflow_1_1log_1_1Log__context.html">Log_context</a>(backup_logger_ptr, <a class="code hl_enumeration" href="namespaceflow.html#a3938730ab4b89daf13d027a5f620e7ce">Flow_log_component</a>::S_LOG),</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>  m_config(config), <span class="comment">// Save pointer, not copy, of the config given to us.  Hence thread safety is a thing.</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>  m_log_path(log_path),</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>  <span class="comment">/* Initialize ostream m_ofs; but this is guaranteed to only mess with, at most, general ostream (not ofstream)</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment">   * state such as locales and formatting; no I/O operations (writing) occur here; if they tried it&#39;d be a problem,</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment">   * as m_ofs is not open yet. */</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span>  m_ofs_writer(*m_config, m_ofs),</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span>  m_reopening(false)</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>{</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span>  <a class="code hl_define" href="log_8hpp.html#a325fdd4b5cf0be49b37d3b7b7c29070d">FLOW_LOG_INFO</a>(<span class="stringliteral">&quot;detail/Serial_file_logger [&quot;</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;] @ [&quot;</span> &lt;&lt; <a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac222fe2511c2350c9ff3e7c95560bfb1">m_log_path</a> &lt;&lt; <span class="stringliteral">&quot;]: These log messages are going to &quot;</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span>                <span class="stringliteral">&quot;associated backup logger [&quot;</span> &lt;&lt; backup_logger_ptr &lt;&lt; <span class="stringliteral">&quot;].  The messages actually logged through &quot;</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>                <span class="stringliteral">&quot;Logger API requests to `*this` will go to aforementioned log path, not to the present output.&quot;</span>);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>  <span class="comment">// Immediately open file in worker thread.  Could be lazy about it but might as well log about any issue ASAP.</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span>  <a class="code hl_function" href="classflow_1_1log_1_1Serial__file__logger.html#a7d38efd094d69b5ef38fc44ba153c9ed">log_flush_and_reopen</a>();</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>  <span class="comment">// ^-- Synchronous.  Doesn&#39;t matter what thread this is: they can&#39;t call do_log() until we return.</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>} <span class="comment">// Serial_file_logger::Serial_file_logger()</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classflow_1_1log_1_1Serial__file__logger.html#a5f69b780548ed452dfbd047a99c6809a">   50</a></span><a class="code hl_function" href="classflow_1_1log_1_1Serial__file__logger.html#a5f69b780548ed452dfbd047a99c6809a">Serial_file_logger::~Serial_file_logger</a>() <span class="comment">// Virtual</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>{</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>  <a class="code hl_define" href="log_8hpp.html#a325fdd4b5cf0be49b37d3b7b7c29070d">FLOW_LOG_INFO</a>(<span class="stringliteral">&quot;detail/Serial_file_logger [&quot;</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;] @ [&quot;</span> &lt;&lt; <a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac222fe2511c2350c9ff3e7c95560bfb1">m_log_path</a> &lt;&lt; <span class="stringliteral">&quot;]: Deleting.  Will flush &quot;</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span>                <span class="stringliteral">&quot;output if possible; then we will proceed to shut down.&quot;</span>);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span>  <span class="keywordflow">if</span> (<a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac42c4ddfd3b664363edf6c38ce942fde">m_ofs</a>.is_open())</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span>  {</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span>    <a class="code hl_define" href="log_8hpp.html#a325fdd4b5cf0be49b37d3b7b7c29070d">FLOW_LOG_INFO</a>(<span class="stringliteral">&quot;detail/Serial_file_logger [&quot;</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;] @ [&quot;</span> &lt;&lt; <a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac222fe2511c2350c9ff3e7c95560bfb1">m_log_path</a> &lt;&lt; <span class="stringliteral">&quot;]: Flushing before destruction &quot;</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>                  <span class="stringliteral">&quot;finishes in other thread.&quot;</span>);</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>    <a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac42c4ddfd3b664363edf6c38ce942fde">m_ofs</a>.flush();</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span>  }</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span>}</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="classflow_1_1log_1_1Serial__file__logger.html#a2604031c07cbb4753bd3563d519a0872">   63</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1log_1_1Serial__file__logger.html#a2604031c07cbb4753bd3563d519a0872">Serial_file_logger::do_log</a>(<a class="code hl_struct" href="structflow_1_1log_1_1Msg__metadata.html">Msg_metadata</a>* metadata, <a class="code hl_typedef" href="namespaceflow_1_1util.html#ae4dc52186797094b3040379ff19124c9">util::String_view</a> msg) <span class="comment">// Virtual.</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span>{</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span>  <span class="comment">/* The current I/O error-handling cycle is set up as follows:</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment">   *   At construction: Attempt open; bool(m_ofs) becomes T or F.  Done.</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment">   *   At do_log() 1: If last op resulted in bool(m_ofs)==F, attempt re-open.  bool(m_ofs) becomes T or F.</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment">   *                  If bool(m_ofs)==T, attempt to write string to m_ofs.  bool(m_ofs) becomes T or F.</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment">   *                    [If F, then string is probably lost forever.]</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment">   *   At do_log() 2: If last op resulted in bool(m_ofs)==F, attempt re-open.  bool(m_ofs) becomes T or F.</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment">   *                  If bool(m_ofs)==T, attempt to write string to m_ofs.  bool(m_ofs) becomes T or F.</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment">   *                    [If F, then string is probably lost forever.]</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment">   *   At do_log() 3: ...etc.</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment">   *</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment">   * The idea is, basically: If the I/O op (either open or write) results in error at the time, retrying is documented</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment">   * as unlikely or impossible to succeed at the time.  So log about any such problems to the *backup* logger but then</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment">   * move on, until the next (later in time) operation is attempted; at which point attempt re-open for max</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment">   * possibility of success.</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment">   *</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment">   * A formal to-do in my doc header is to perhaps buffer any failed impl_do_log()s, so they can be output upon</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment">   * hypothetical successful reopen later. */</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span>  <span class="keywordflow">if</span> (!<a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac42c4ddfd3b664363edf6c38ce942fde">m_ofs</a>)</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span>  {</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span>    <a class="code hl_define" href="log_8hpp.html#a626c7dc4d3b4dc0b32a8aac8624d66bc">FLOW_LOG_WARNING</a>(<span class="stringliteral">&quot;detail/Serial_file_logger [&quot;</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;] @ [&quot;</span> &lt;&lt; <a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac222fe2511c2350c9ff3e7c95560bfb1">m_log_path</a> &lt;&lt; <span class="stringliteral">&quot;]: do_log() wants to log, but &quot;</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span>                     <span class="stringliteral">&quot;file stream is in bad state, spuriously or due to a previous op; will attempt reopen first.&quot;</span>);</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span>    <a class="code hl_function" href="classflow_1_1log_1_1Serial__file__logger.html#a7d38efd094d69b5ef38fc44ba153c9ed">log_flush_and_reopen</a>();</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span>    <span class="keywordflow">if</span> (!<a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac42c4ddfd3b664363edf6c38ce942fde">m_ofs</a>)</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span>    {</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span>      <a class="code hl_define" href="log_8hpp.html#a626c7dc4d3b4dc0b32a8aac8624d66bc">FLOW_LOG_WARNING</a>(<span class="stringliteral">&quot;detail/Serial_file_logger [&quot;</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;] @ [&quot;</span> &lt;&lt; <a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac222fe2511c2350c9ff3e7c95560bfb1">m_log_path</a> &lt;&lt; <span class="stringliteral">&quot;]: &quot;</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span>                       <span class="stringliteral">&quot;Stream still in bad state; giving up on that log message.  &quot;</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span>                       <span class="stringliteral">&quot;Will retry file stream for next message.&quot;</span>);</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span>      <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span>    }</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span>    <span class="comment">// else { Cool, re-open succeeded, so fall through to in fact log. }</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span>  }</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span>  <span class="comment">// else { Was in good state after last op; no reason to suspect otherwise now. }</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span>  assert(<a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac42c4ddfd3b664363edf6c38ce942fde">m_ofs</a>);</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span> </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span>  <a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#a92ed6ae3183bbd1f4905245f485cb531">m_ofs_writer</a>.<a class="code hl_function" href="classflow_1_1log_1_1Ostream__log__msg__writer.html#aba0a94e36e435aeb67bbc25fee8380f7">log</a>(*metadata, msg);</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span>  <span class="keywordflow">if</span> (!<a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac42c4ddfd3b664363edf6c38ce942fde">m_ofs</a>)</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span>  {</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span>    <a class="code hl_define" href="log_8hpp.html#a626c7dc4d3b4dc0b32a8aac8624d66bc">FLOW_LOG_WARNING</a></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span>      (<span class="stringliteral">&quot;detail/Serial_file_logger [&quot;</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;] @ [&quot;</span> &lt;&lt; <a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac222fe2511c2350c9ff3e7c95560bfb1">m_log_path</a> &lt;&lt; <span class="stringliteral">&quot;]: do_log() just tried to log &quot;</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span>       <span class="stringliteral">&quot;msg when file stream was in good state, but now file stream is in bad state, probably because the &quot;</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span>       <span class="stringliteral">&quot;write failed.  Giving up on that log message.  Will retry file stream for next message.&quot;</span>);</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span>  }</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span>} <span class="comment">// Serial_file_logger::do_log()</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"><a class="line" href="classflow_1_1log_1_1Serial__file__logger.html#a7d38efd094d69b5ef38fc44ba153c9ed">  111</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1log_1_1Serial__file__logger.html#a7d38efd094d69b5ef38fc44ba153c9ed">Serial_file_logger::log_flush_and_reopen</a>()</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span>{</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span>  <span class="comment">// See notes in do_log() about the error handling cycle.</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span> </div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span>  <span class="comment">/* Discussion of us logging through *this, meaning FLOW_LOG_*() to our own target file:</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment">   * It&#39;s easy to do: FLOW_LOG_SET_LOGGER(this); and then just do it.  However, logging while enabling the user to</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment">   * log naturally raises fears of infinite loops/recursion:</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment">   *   - do_log() can detect m_ofs bad state and trigger log_flush_and_reopen() which then FLOW_LOG_*()s which</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment">   *     do_log()s which....</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment">   *   - log_flush_and_reopen() may be called by user which FLOW_LOG_*()s (as it should) which do_log()s which</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment">   *     can detect m_ofs bad state and trigger log_flush_and_reopen() which then....</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment">   *</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment">   * So we do this to simply never execute log_flush_and_reopen() logic if currently called from it in the first</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment">   * place.  If necessary the on-error log_flush_and_reopen() will be re-attempted from the next user do_log().</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment">   *</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment">   * In addition, just to avoid entropy, we do not log to *this logger (the first and last lines per log file)</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment">   * if m_ofs is in bad state (is falsy).  We could, and it would just fail, but it&#39;s best to just not.</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment">   * As of this writing, actually, that m_ofs check would be sufficient to prevent the recursion problem by itself;</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment">   * but this felt too brittle (easy to break with an inadvertent change). */</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span>  <span class="keywordflow">if</span> (<a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#a1e8b20725c1ce10cd996da75fc098a87">m_reopening</a>)</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span>  {</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span>    <a class="code hl_define" href="log_8hpp.html#affcf2e4c496ce3f42adf981669c623b8">FLOW_LOG_TRACE</a>(<span class="stringliteral">&quot;detail/Serial_file_logger [&quot;</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;] @ [&quot;</span> &lt;&lt; <a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac222fe2511c2350c9ff3e7c95560bfb1">m_log_path</a> &lt;&lt; <span class="stringliteral">&quot;]: Reopen method invoked &quot;</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span>                   <span class="stringliteral">&quot;by internal code while already being asked to reopen file.  Doing nothing.&quot;</span>);</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span>    <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span>  }</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span>  <span class="comment">// else</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span>  <a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#a1e8b20725c1ce10cd996da75fc098a87">m_reopening</a> = <span class="keyword">true</span>;</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span> </div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span>  <span class="comment">// Use inline lambda to ensure no matter how the below returns, we execute `m_reopening = false;` at the end.</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span>  ([&amp;]()</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span>  {</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span>    <span class="keywordflow">if</span> (<a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac42c4ddfd3b664363edf6c38ce942fde">m_ofs</a>.is_open())</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span>    {</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span>      <a class="code hl_define" href="log_8hpp.html#a325fdd4b5cf0be49b37d3b7b7c29070d">FLOW_LOG_INFO</a>(<span class="stringliteral">&quot;detail/Serial_file_logger [&quot;</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;] @ [&quot;</span> &lt;&lt; <a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac222fe2511c2350c9ff3e7c95560bfb1">m_log_path</a> &lt;&lt; <span class="stringliteral">&quot;]: Closing before re-opening.&quot;</span>);</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span>      <span class="keywordflow">if</span> (<a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac42c4ddfd3b664363edf6c38ce942fde">m_ofs</a>) <span class="comment">// As noted above, avoid entropy if stream is in bad state anyway.</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span>      {</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span>        <span class="comment">/* This shall be *the* last message logged before the close.  If part of a rotation operation -- a HUP sent</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment">         * to us to cause log_flush_and_reopen() to execute -- then it&#39;ll be the last message in the file, which is</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment">         * renamed before the HUP is sent.</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment">         *</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment">         * This *will* invoke do_log() -- but that do_log() *will not* invoke us again/infinitely due to</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment">         * the m_reopening check at the top, at a minimum; plus as of this writing do_log() will not invoke us</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment">         * at all, as it only triggers log_flush_and_reopen() if !m_ofs... but we just guaranteed the opposite. */</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span>        <a class="code hl_define" href="log_8hpp.html#ad4958fbd8673f48be76bf8e5e11d0522">FLOW_LOG_SET_LOGGER</a>(<span class="keyword">this</span>);</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span>        <a class="code hl_define" href="log_8hpp.html#a325fdd4b5cf0be49b37d3b7b7c29070d">FLOW_LOG_INFO</a>(<span class="stringliteral">&quot;detail/Serial_file_logger [&quot;</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;] @ [&quot;</span> &lt;&lt; <a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac222fe2511c2350c9ff3e7c95560bfb1">m_log_path</a> &lt;&lt; <span class="stringliteral">&quot;]: &quot;</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span>                      <span class="stringliteral">&quot;Closing before re-opening.&quot;</span>);</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span>      }</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span> </div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span>      <a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac42c4ddfd3b664363edf6c38ce942fde">m_ofs</a>.flush(); <span class="comment">// m_ofs_writer `flush`es after each message... but just in case.</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span>      <a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac42c4ddfd3b664363edf6c38ce942fde">m_ofs</a>.close();</div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span>    }</div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span> </div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span>    <a class="code hl_define" href="log_8hpp.html#a325fdd4b5cf0be49b37d3b7b7c29070d">FLOW_LOG_INFO</a>(<span class="stringliteral">&quot;detail/Serial_file_logger [&quot;</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;] @ [&quot;</span> &lt;&lt; <a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac222fe2511c2350c9ff3e7c95560bfb1">m_log_path</a> &lt;&lt; <span class="stringliteral">&quot;]: &quot;</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span>                  <span class="stringliteral">&quot;Opening for append.  Will log on error.&quot;</span>);</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span>    <a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac42c4ddfd3b664363edf6c38ce942fde">m_ofs</a>.open(<a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac222fe2511c2350c9ff3e7c95560bfb1">m_log_path</a>, std::ios_base::app);</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span> </div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span>    <span class="keywordflow">if</span> (<a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac42c4ddfd3b664363edf6c38ce942fde">m_ofs</a>) <span class="comment">// As noted above, avoid entropy if stream is in bad state anyway.</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span>    {</div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span>      <span class="comment">/* This shall be *the* first message logged after the re-open.  If part of a rotation operation (see above),</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="comment">       * then it&#39;ll be the first message in the new file, as the preceding file has been renamed, while we were still</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="comment">       * writing to it. */</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span>      <a class="code hl_define" href="log_8hpp.html#ad4958fbd8673f48be76bf8e5e11d0522">FLOW_LOG_SET_LOGGER</a>(<span class="keyword">this</span>);</div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span>      <a class="code hl_define" href="log_8hpp.html#a325fdd4b5cf0be49b37d3b7b7c29070d">FLOW_LOG_INFO</a>(<span class="stringliteral">&quot;detail/Serial_file_logger [&quot;</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;] @ [&quot;</span> &lt;&lt; <a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac222fe2511c2350c9ff3e7c95560bfb1">m_log_path</a> &lt;&lt; <span class="stringliteral">&quot;]: &quot;</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span>                    <span class="stringliteral">&quot;Opened successfully for further logging.&quot;</span>);</div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span>      <a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#ac42c4ddfd3b664363edf6c38ce942fde">m_ofs</a>.flush(); <span class="comment">// m_ofs_writer `flush`es after each message... but just in case.</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span>    }</div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span>    <span class="keywordflow">else</span> <span class="comment">// if (!m_ofs)</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span>    {</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span>      <a class="code hl_define" href="log_8hpp.html#a626c7dc4d3b4dc0b32a8aac8624d66bc">FLOW_LOG_WARNING</a>(<span class="stringliteral">&quot;Could not open.  Will probably retry subsequently.&quot;</span>);</div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span>    }</div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span>  })();</div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span> </div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span>  <a class="code hl_variable" href="classflow_1_1log_1_1Serial__file__logger.html#a1e8b20725c1ce10cd996da75fc098a87">m_reopening</a> = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span>} <span class="comment">// Serial_file_logger::log_flush_and_reopen()</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span> </div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"><a class="line" href="classflow_1_1log_1_1Serial__file__logger.html#ad602948de59867b3a85c7f0dd6620497">  186</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1log_1_1Serial__file__logger.html#ad602948de59867b3a85c7f0dd6620497">Serial_file_logger::should_log</a>(<a class="code hl_enumeration" href="namespaceflow_1_1log.html#a5c602384e6fe9d7642740ac2fae4ad04">Sev</a> sev, <span class="keyword">const</span> <a class="code hl_class" href="classflow_1_1log_1_1Component.html">Component</a>&amp; component) <span class="keyword">const</span> <span class="comment">// Virtual.</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span>{</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span>  <span class="keywordflow">return</span> m_config-&gt;output_whether_should_log(sev, component);</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span>}</div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span> </div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"><a class="line" href="classflow_1_1log_1_1Serial__file__logger.html#a591d96ecc030af0b40c42a33e2a616d9">  191</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1log_1_1Serial__file__logger.html#a591d96ecc030af0b40c42a33e2a616d9">Serial_file_logger::logs_asynchronously</a>() const <span class="comment">// Virtual.</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span>{</div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span>}</div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span> </div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span>} <span class="comment">// namespace flow::log</span></div>
<div class="ttc" id="aclassflow_1_1log_1_1Component_html"><div class="ttname"><a href="classflow_1_1log_1_1Component.html">flow::log::Component</a></div><div class="ttdoc">A light-weight class, each object storing a component payload encoding an enum value from enum type o...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l00839">log.hpp:840</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Config_html"><div class="ttname"><a href="classflow_1_1log_1_1Config.html">flow::log::Config</a></div><div class="ttdoc">Class used to configure the filtering and logging behavior of Loggers; its use in your custom Loggers...</div><div class="ttdef"><b>Definition:</b> <a href="config_8hpp_source.html#l00316">config.hpp:317</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Log__context_html"><div class="ttname"><a href="classflow_1_1log_1_1Log__context.html">flow::log::Log_context</a></div><div class="ttdoc">Convenience class that simply stores a Logger and/or Component passed into a constructor; and returns...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l01609">log.hpp:1610</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Logger_html"><div class="ttname"><a href="classflow_1_1log_1_1Logger.html">flow::log::Logger</a></div><div class="ttdoc">Interface that the user should implement, passing the implementing Logger into logging classes (Flow'...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l01280">log.hpp:1284</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Ostream__log__msg__writer_html_aba0a94e36e435aeb67bbc25fee8380f7"><div class="ttname"><a href="classflow_1_1log_1_1Ostream__log__msg__writer.html#aba0a94e36e435aeb67bbc25fee8380f7">flow::log::Ostream_log_msg_writer::log</a></div><div class="ttdeci">void log(const Msg_metadata &amp;metadata, util::String_view msg)</div><div class="ttdoc">Logs to the wrapped ostream the given message and associated metadata like severity and time stamp; p...</div><div class="ttdef"><b>Definition:</b> <a href="ostream__log__msg__writer_8cpp_source.html#l00074">ostream_log_msg_writer.cpp:74</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Serial__file__logger_html_a1e8b20725c1ce10cd996da75fc098a87"><div class="ttname"><a href="classflow_1_1log_1_1Serial__file__logger.html#a1e8b20725c1ce10cd996da75fc098a87">flow::log::Serial_file_logger::m_reopening</a></div><div class="ttdeci">bool m_reopening</div><div class="ttdoc">Starts at false, becomes true at entry to log_flush_and_reopen(), then becomes false again.</div><div class="ttdef"><b>Definition:</b> <a href="serial__file__logger_8hpp_source.html#l00133">serial_file_logger.hpp:133</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Serial__file__logger_html_a2604031c07cbb4753bd3563d519a0872"><div class="ttname"><a href="classflow_1_1log_1_1Serial__file__logger.html#a2604031c07cbb4753bd3563d519a0872">flow::log::Serial_file_logger::do_log</a></div><div class="ttdeci">void do_log(Msg_metadata *metadata, util::String_view msg) override</div><div class="ttdoc">Implements interface method by synchronously logging the message and some subset of the metadata in a...</div><div class="ttdef"><b>Definition:</b> <a href="serial__file__logger_8cpp_source.html#l00063">serial_file_logger.cpp:63</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Serial__file__logger_html_a591d96ecc030af0b40c42a33e2a616d9"><div class="ttname"><a href="classflow_1_1log_1_1Serial__file__logger.html#a591d96ecc030af0b40c42a33e2a616d9">flow::log::Serial_file_logger::logs_asynchronously</a></div><div class="ttdeci">bool logs_asynchronously() const override</div><div class="ttdoc">Implements interface method by returning false, indicating that this Logger will not need the content...</div><div class="ttdef"><b>Definition:</b> <a href="serial__file__logger_8cpp_source.html#l00191">serial_file_logger.cpp:191</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Serial__file__logger_html_a5f69b780548ed452dfbd047a99c6809a"><div class="ttname"><a href="classflow_1_1log_1_1Serial__file__logger.html#a5f69b780548ed452dfbd047a99c6809a">flow::log::Serial_file_logger::~Serial_file_logger</a></div><div class="ttdeci">~Serial_file_logger() override</div><div class="ttdoc">Flushes out anything buffered, returns resources/closes output file(s); then returns.</div><div class="ttdef"><b>Definition:</b> <a href="serial__file__logger_8cpp_source.html#l00050">serial_file_logger.cpp:50</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Serial__file__logger_html_a7d38efd094d69b5ef38fc44ba153c9ed"><div class="ttname"><a href="classflow_1_1log_1_1Serial__file__logger.html#a7d38efd094d69b5ef38fc44ba153c9ed">flow::log::Serial_file_logger::log_flush_and_reopen</a></div><div class="ttdeci">void log_flush_and_reopen()</div><div class="ttdoc">Causes the log at the file-system path to be flushed/closed (if needed) and re-opened; this will occu...</div><div class="ttdef"><b>Definition:</b> <a href="serial__file__logger_8cpp_source.html#l00111">serial_file_logger.cpp:111</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Serial__file__logger_html_a92ed6ae3183bbd1f4905245f485cb531"><div class="ttname"><a href="classflow_1_1log_1_1Serial__file__logger.html#a92ed6ae3183bbd1f4905245f485cb531">flow::log::Serial_file_logger::m_ofs_writer</a></div><div class="ttdeci">Ostream_log_msg_writer m_ofs_writer</div><div class="ttdoc">Stream writer via which to log messages to m_ofs.</div><div class="ttdef"><b>Definition:</b> <a href="serial__file__logger_8hpp_source.html#l00127">serial_file_logger.hpp:127</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Serial__file__logger_html_a979efc0eb7577c2175c8fe9debdced94"><div class="ttname"><a href="classflow_1_1log_1_1Serial__file__logger.html#a979efc0eb7577c2175c8fe9debdced94">flow::log::Serial_file_logger::Serial_file_logger</a></div><div class="ttdeci">Serial_file_logger(Logger *backup_logger_ptr, Config *config, const fs::path &amp;log_path)</div><div class="ttdoc">Constructs logger to subsequently log to the given file-system path.</div><div class="ttdef"><b>Definition:</b> <a href="serial__file__logger_8cpp_source.html#l00027">serial_file_logger.cpp:27</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Serial__file__logger_html_ac222fe2511c2350c9ff3e7c95560bfb1"><div class="ttname"><a href="classflow_1_1log_1_1Serial__file__logger.html#ac222fe2511c2350c9ff3e7c95560bfb1">flow::log::Serial_file_logger::m_log_path</a></div><div class="ttdeci">const fs::path m_log_path</div><div class="ttdoc">File-system path to which to write subsequently.</div><div class="ttdef"><b>Definition:</b> <a href="serial__file__logger_8hpp_source.html#l00117">serial_file_logger.hpp:117</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Serial__file__logger_html_ac42c4ddfd3b664363edf6c38ce942fde"><div class="ttname"><a href="classflow_1_1log_1_1Serial__file__logger.html#ac42c4ddfd3b664363edf6c38ce942fde">flow::log::Serial_file_logger::m_ofs</a></div><div class="ttdeci">fs::ofstream m_ofs</div><div class="ttdoc">The file to which to write. Because only the worker thread ever accesses it, no mutex is needed.</div><div class="ttdef"><b>Definition:</b> <a href="serial__file__logger_8hpp_source.html#l00120">serial_file_logger.hpp:120</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Serial__file__logger_html_ad602948de59867b3a85c7f0dd6620497"><div class="ttname"><a href="classflow_1_1log_1_1Serial__file__logger.html#ad602948de59867b3a85c7f0dd6620497">flow::log::Serial_file_logger::should_log</a></div><div class="ttdeci">bool should_log(Sev sev, const Component &amp;component) const override</div><div class="ttdoc">See Async_file_logger::should_log().</div><div class="ttdef"><b>Definition:</b> <a href="serial__file__logger_8cpp_source.html#l00186">serial_file_logger.cpp:186</a></div></div>
<div class="ttc" id="aconfig_8hpp_html"><div class="ttname"><a href="config_8hpp.html">config.hpp</a></div></div>
<div class="ttc" id="alog_8hpp_html_a325fdd4b5cf0be49b37d3b7b7c29070d"><div class="ttname"><a href="log_8hpp.html#a325fdd4b5cf0be49b37d3b7b7c29070d">FLOW_LOG_INFO</a></div><div class="ttdeci">#define FLOW_LOG_INFO(ARG_stream_fragment)</div><div class="ttdoc">Logs an INFO message into flow::log::Logger *get_logger() with flow::log::Component get_log_component...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l00197">log.hpp:197</a></div></div>
<div class="ttc" id="alog_8hpp_html_a626c7dc4d3b4dc0b32a8aac8624d66bc"><div class="ttname"><a href="log_8hpp.html#a626c7dc4d3b4dc0b32a8aac8624d66bc">FLOW_LOG_WARNING</a></div><div class="ttdeci">#define FLOW_LOG_WARNING(ARG_stream_fragment)</div><div class="ttdoc">Logs a WARNING message into flow::log::Logger *get_logger() with flow::log::Component get_log_compone...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l00152">log.hpp:152</a></div></div>
<div class="ttc" id="alog_8hpp_html_ad4958fbd8673f48be76bf8e5e11d0522"><div class="ttname"><a href="log_8hpp.html#ad4958fbd8673f48be76bf8e5e11d0522">FLOW_LOG_SET_LOGGER</a></div><div class="ttdeci">#define FLOW_LOG_SET_LOGGER(ARG_logger_ptr)</div><div class="ttdoc">Equivalent to FLOW_LOG_SET_CONTEXT() but sets the get_logger only.</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l00415">log.hpp:415</a></div></div>
<div class="ttc" id="alog_8hpp_html_affcf2e4c496ce3f42adf981669c623b8"><div class="ttname"><a href="log_8hpp.html#affcf2e4c496ce3f42adf981669c623b8">FLOW_LOG_TRACE</a></div><div class="ttdeci">#define FLOW_LOG_TRACE(ARG_stream_fragment)</div><div class="ttdoc">Logs a TRACE message into flow::log::Logger *get_logger() with flow::log::Component get_log_component...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l00227">log.hpp:227</a></div></div>
<div class="ttc" id="anamespaceflow_1_1log_html"><div class="ttname"><a href="namespaceflow_1_1log.html">flow::log</a></div><div class="ttdoc">Flow module providing logging functionality.</div><div class="ttdef"><b>Definition:</b> <a href="async__file__logger_8cpp_source.html#l00027">async_file_logger.cpp:28</a></div></div>
<div class="ttc" id="anamespaceflow_1_1log_html_a5c602384e6fe9d7642740ac2fae4ad04"><div class="ttname"><a href="namespaceflow_1_1log.html#a5c602384e6fe9d7642740ac2fae4ad04">flow::log::Sev</a></div><div class="ttdeci">Sev</div><div class="ttdoc">Enumeration containing one of several message severity levels, ordered from highest to lowest.</div><div class="ttdef"><b>Definition:</b> <a href="log__fwd_8hpp_source.html#l00223">log_fwd.hpp:224</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_ae4dc52186797094b3040379ff19124c9"><div class="ttname"><a href="namespaceflow_1_1util.html#ae4dc52186797094b3040379ff19124c9">flow::util::String_view</a></div><div class="ttdeci">Basic_string_view&lt; char &gt; String_view</div><div class="ttdoc">Commonly used char-based Basic_string_view. See its doc header.</div><div class="ttdef"><b>Definition:</b> <a href="string__view_8hpp_source.html#l00191">string_view.hpp:191</a></div></div>
<div class="ttc" id="anamespaceflow_html_a3938730ab4b89daf13d027a5f620e7ce"><div class="ttname"><a href="namespaceflow.html#a3938730ab4b89daf13d027a5f620e7ce">flow::Flow_log_component</a></div><div class="ttdeci">Flow_log_component</div><div class="ttdoc">The flow::log::Component payload enumeration comprising various log components used by Flow's own int...</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00637">common.hpp:638</a></div></div>
<div class="ttc" id="aserial__file__logger_8hpp_html"><div class="ttname"><a href="serial__file__logger_8hpp.html">serial_file_logger.hpp</a></div></div>
<div class="ttc" id="astructflow_1_1log_1_1Msg__metadata_html"><div class="ttname"><a href="structflow_1_1log_1_1Msg__metadata.html">flow::log::Msg_metadata</a></div><div class="ttdoc">Simple data store containing all of the information generated at every logging call site by flow::log...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l01040">log.hpp:1041</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 28 2025 22:55:35 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
